Categories:
Aura configuration API skill module
Skill module description for aura-configuration-api
Introduction
The skill module defines services associated with skills management in aura-configuration-api server.
All these services are defined in the skills namespace (/skills).
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/skills/
- aura-services/v2/configuration/skills/{skillId}
Endpoints
| Path | Method | Description |
|---|---|---|
| /skills/ | GET | Get all skills information |
| /skills/ | POST | Add a new skill |
| /skills/{skillId} | GET | Get skill information using skill id |
| /skills/{skillId} | PUT | Replace skill information associated to skill id |
| /skills/{skillId} | PATCH | Update some fields of skill information using skill id |
| /skills/{skillId} | DELETE | Delete skill information using skill id |
You can read the complete documentation of each service in the aura-configuration-api swagger file.
Retrieving information from skills
Retrieving only some fields in skill information
It is possible to get only a specific list of fields for skill 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/skills?includeFields=name,skillEndpoint' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: XXX'
Response example:
[
{
"id": "45494a5b-835a-4fff-a813-b3d2be529dbe",
"name": "aura-bot-skill-1",
"skillEndpoint": "http://localhost:8081/api/messages"
},
{
"id": "71b626d0-099f-4184-8abb-b035d3aa4b16",
"name": "aura-bot-skill-2",
"skillEndpoint": "http://localhost:8082/api/messages"
}
]
Excluding fields in skills information
It is also possible to exclude skills information fields using the excludeFields query parameter.
curl --location --request GET 'http://aura-configuration-api:8999/aura-services/v2/configuration/skills?excludeFields=skillEndpoint,metadata' \
--header 'correlator: urn:uuid:c8a604ee-29f8-7cda-2979-d2ae6189c360' \
--header 'Accept: application/json' \
--header 'Authorization: APIKEY XXX'
Response example:
[
{
"id": "45494a5b-835a-4fff-a813-b3d2be529dbe",
"name": "aura-bot-skill-1",
"apiId": "45494a5b-835a-4fff-a813-b3d2be529asd",
"channels": ["whatsapp"]
},
{
"id": "71b626d0-099f-4184-8abb-b035d3aa4b16",
"name": "aura-bot-skill-2",
"appId": "71b626d0-099f-4184-8abb-b035d3aa4f45",
"channels": ["novum"]
}
]
Database
The complete definition of the data model can be found in skills collection section within the administration module.