BETA

Skip links

  • Skip to primary navigation
  • Skip to content
  • Skip to footer
Queensland government logo Queensland government logo
Sign in Sign out
Sign in
  • Profile summary
  • Sign out
Department of Education Department of Education Developer Portal
  • Home
  • Tags
  • Chat
  • New
    APIs
  • Help
  • Contact us
  • Dark mode
  • Home
  • Tags
  • Chat
  • New
    APIs
  • Help
  • Contact us
  • My profile
  • Dark mode

LiveDoc - Code documentation and dependancy reporting features

Jeny Amatya Government
by Jeny Amatya
29 October 2024
Last updated 24 March 2025
AI opinion Source code
AI opinion Source code

Note: Since this post was published, we have combined the dependency scanning tool with our LiveDoc service.

Overview

The Developer Portal includes a tool called the dependency scanning tool, which allows users to scan source repositories (currently only GitHub is supported) for any references to assemblies that may be deprecated or targeted for removal by a software team.

Usage

  1. Setup
    • Obtain an API key from the Developer Portal..
    • Configure Postman with the base URL for the dependency scanning API.
  2. Configure input parameters
    • Admin users can define the configuration/parameters for scanning a repository in the Admin > Dependency scanning section. Here, we can specify details like:
      • Name of the source repository
      • URL of the repository
      • Output report format
      • Name and version of deprecated packages to be scanned
    • These configurations are stored in CosmosDB and can be accessed using a unique repository key.
    • Dependency scanning configuration
  3. API call
    • Send a GET request to initiate the scan, including both the repository key and API key in the request headers.
    • Dependency scanning API call
  4. Scan report
    • The scan results are saved to Azure blob storage, with the location specified in the response to the scan response.
    • Dependency scanning API response
Powered by Link to AI chat
  • Copyright
  • Disclaimer
  • Privacy
  • Right to information
  • Accessibility
  • Jobs in Queensland Government
  • Other languages

© The State of Queensland (Department of Education) 2025

Queensland Government