Will it be possible to easily see what APIs have been deployed from a DataMiner system using User Defined API without having to look at the individual automation scripts?
Has it also been considered already to add the possibility to extract documentation (for example Swagger Specification) for the deployed APIs?
Hi Joey,
In Cube, there is currently a simple UI available that gives you an overview of all APIs & tokens. Note that this is currently in soft-launch and may change in the future. The 'Viewing APIs and tokens in DataMiner Cube' docs page that Matthias linked in his reply contains a little bit more info.
For that second question. We have already investigated whether it is possible to extract an OpenAPI specification from the APIs you created, but unfortunately, there is too much missing information at the moment. A lot of the behavior of your API is defined in the C# script code which would be very hard to reliably extract. It would however be possible to let the user define this additional info (allowed request methods, expected input and output format etc.) using tags or additional config on the API. But we fear that, at that point, you could just document this yourself. (using eg https://editor.swagger.io/)
Hi Joey,
Answer for question 1: Yes, this is possible:
- server: check logging file SLUserDefinableApiManager.txt
- Cube: check DataMiner logging "User-defined API Manager"
FYI: We just noticed that this is not included in the docs. This will be updated ASAP.
Answer for question 2: the following documentation is already present in the public docs:
- User-Defined APIs
- Viewing APIs and tokens in DataMiner Cube
- Triggering a user-defined API
NOTE: this feature is still in preview (soft-launch) for DM 10.3.5.0.
Hi Matthias, documentation on the functionality itself is great 🙂 I am more referring to documentation on the APIs you have exposed as a user.
I would presume we can extract all the “unnecessary” configuration that is now in code and use a more framework native approach for this.