Documentation Changelog

2.1.0

  • Upgrade: Swagger UI updated to v4.13.0.

  • Feature: Updated Swagger with better layout for “Schema” section.

  • Feature: Added section on system versions.

  • Feature: Updated the overview of the web interface with new screenshot and annotations for both desktop and mobile view.

  • Feature: Consolidation on a number of different sections to make the documentation easier to follow and remove duplicate sections.

  • Feature: New screenshots and icons added to match current systems.

  • Feature: Poor quality or difficult to read screenshots, images and icons have been removed or replaced with higher quality.

  • Feature: Details about “Calculation Adjusted” messages in a response.

  • Feature: /bsa, /my-metrics and /clutter/delete/0 endpoints added to Swagger UI.

  • Feature: Added Terrain_AMSL, Landcover distance, Landcover codes and Landcover heights on /path request in Swagger UI.

  • Feature: Added annotated overview of a number of different menus and tools.

  • Feature: Added “Account Information” and API ready scripts sections.

  • Feature: Minified all images to reduce page size and page load times.

  • Feature: Innovation roadmap extended to current day.

  • Feature: Improvements to a number of different headings to allow for better nesting.

  • Fix: Removed API reference document from Sphinx/ReadTheDocs as was causing confusion. Unique contents from the old reference have been moved to Swagger UI.

  • Fix: Removed “Support Ticket” section on “About Cloud-RF” page as is no longer present.

  • Fix: Broken markdown styling on some icons.

  • Fix: “View Home” details are incorrect.

  • Fix: Updated measured units to list all available units.

  • Fix: Missing or incorrect values/types on /path example response in Swagger UI.

  • Fix: Swagger UI gives incomplete endpoint for retrieving clutter.

  • Fix: Swagger UI updated with engine parameter for /area calculations.

  • Fix: Naming of “Mesh” to “Super Layer” on “Web Interface RF Tools” page.

  • Fix: Clutter section on “Web Interface Map” listing historic management of height data.

  • Fix: Issue on clm in Swagger UI with default values.

  • Fix: Missing fbr option in the output “Schema” section.

  • Fix: Updated noise floor accepted range in Swagger UI.

  • Fix: area value from /area calculation response schema updated in Swagger UI as km2 value is no longer appended.

2.0.1

  • Support for API 2.8, UI 2.7 and Sleipnir 1.5.9.

  • Added component versions to beginning of documentation.

  • Fixed PDF where everything was under a “Contents” heading.

  • Improvements to internal tooling to allow for better standardisation of documentation.

2.0.0

  • Changed to Sphinx “Read the Docs” template.

  • PDF included in documentation.

  • Added search functionaltiy.

  • Added satellite and MANET tools.

  • Consolidated docs.cloudrf.com & https://cloudrf.com/documentation/developer/swagger-ui/.

  • Added “Import Multiple Points from CSV” section to interface_map.

  • Improvements to internal tooling and processes.