Categories:
Aura configuration API component module
Component module description for aura-configuration-api
Introduction
The component module defines services associated with components management in aura-configuration-api server.
All these services are defined in the components namespace (/components).
Components will be automatically loaded with Aura deployments.
Servers definition
By default, the servers defined in the swagger include the base path (for v2): /aura-services/v2/configuration.
Therefore, in order to access the services, the base path and service path must be used.
Examples:
- aura-services/v2/configuration/components/
- aura-services/v2/configuration/components/{name}
Endpoints
| Path | Method | Description |
|---|---|---|
| /components/ | GET | Get all components information |
| /components/ | POST | Add a new component |
| /components/{name} | GET | Get component information using name |
| /components/{name} | DELETE | Delete component information using name |
You can read the complete documentation of each service in the aura-configuration-api swagger file.
Retrieving information from components
Retrieving only some fields in component information
It is possible to get only a specific list of fields for component information, reducing the amount of data transmitted when necessary, using the includeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/components?includeFields=name,prefix' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "ab09f8af-18e2-46ed-b103-934df78277c0",
"name": "aura-bot",
}
]
Excluding fields in components information
It is also possible to exclude components information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/components?excludeFields=dialogLibraries,nlp,requestOptions,responseOptions' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "ab09f8af-18e2-46ed-b103-934df78277c0",
"name": "aura-bot"
}
]
Database
The complete definition of the data model can be found in components collection section within the Administration module.