Categories:
Aura Configuration API modules
Description of the different modules that compose Aura Configuration API
Introduction
Currently, aura-configuration-api contains the following modules:
Administration module
Module in charge of administration tasks:
- Export of complete server information.
- Export of information by modules.
- Import of complete server information.
- Import of information by modules.
Access detailed information about Administration module.
Channel module
Module responsible for managing all the information related to channels, including the configuration of each Aura channel as well as the libraries associated with each channel (replacement for the bot-response.json configuration file).
- Add channel
- Delete channel by id
- Get channel by id
- Get all channels
- Get changed channels
- Modify channel
- Update channel
Access detailed information about Channel module.
Component module
Module responsible for managing all the information related to components, including the configuration of each Aura component.
- Add new components
- Delete component by name
- Get component by name
- Get all components
- Update component by name
- Modify component by name
Access detailed information about Component module.
Skill module
Module responsible for managing all the information related to skills, defining the following operations:
- Add skill
- Delete skill by id
- Get skill by id
- Get all skills
- Get changed skills
- Modify skill
- Update skill
Access detailed information about Skill module.
Application module
Module responsible for managing all the information related to applications, defining the following operations:
- Add application
- Delete application by id
- Get application by id
- Get all applications
- Get changed applications
- Modify application
- Update application
Access detailed information about Application module.
Library
Module responsible for managing all the information related to libraries, defining the following operations:
- Add library by channel id
- Delete all libraries by channel id
- Delete library by id and channel id
- Get library by id and channel id
- Update library by channel id
From the functional point of view, this module depends on the aura-configuration-api channel module: server definition.
Prometheus
Module responsible for exposing metrics for monitoring and observability of Aura Configuration API using Prometheus. It provides metrics such as:
- Aura component version (gauge)
- Unhandled server errors (counter)
- Outgoing message duration (summary)
- Outgoing request duration (summary)
These metrics help track the health, performance, and errors of the API. Paths in metrics are normalized for aggregation. For more details, see the Prometheus metrics registration source code.
Access detailed information about Prometheus module.