Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Updates & Insights
  • Questions
  • Learning
    • E-learning Courses
    • Empower Replay: Limited Edition
    • Tutorials
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
      • About the DevOps Program
      • DataMiner DevOps Support
  • Downloads
  • More
    • DataMiner Releases & Updates
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

User Defined API – Overview and documentation of deployed APIs

Solved1.89K views31st March 2023user defined API
6
Joey Vanhalst [SLC] [DevOps Advocate]1.80K 31st March 2023 0 Comments

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?

Joey Vanhalst [SLC] [DevOps Advocate] Selected answer as best 31st March 2023

2 Answers

  • Active
  • Voted
  • Newest
  • Oldest
10
Thomas Ghysbrecht [SLC] [DevOps Enabler]4.84K Posted 31st March 2023 1 Comment

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/)

Baptiste Pattyn [SLC] [DevOps Advocate] Posted new comment 3rd April 2023
Baptiste Pattyn [SLC] [DevOps Advocate] commented 3rd April 2023

I would presume we can extract all the “unnecessary” configuration that is now in code and use a more framework native approach for this.

You are viewing 1 out of 2 answers, click here to view all answers.
Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs

[ Placeholder content for popup link ] WordPress Download Manager - Best Download Management Plugin