Skip to content

Progress Bar addition to DataGateway - Feature Parity #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Cevan00 wants to merge 1 commit into from
Closed

Progress Bar addition to DataGateway - Feature Parity #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions specs/Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,57 @@
"title": "Core System - Health Report",
"type": "object"
},
"Core.ProgressBar": {
"title": "Core - Progress Bar",
"description": "Used to indicate the progress of a long running operation.",
"properties": {
"childBar": {
"description": "Sub progress bar that should appear below the current progress bar for a dependent execution branch.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/Core.ProgressBar"
}
},
"description": {
"type": "string",
"description": "Long form text describing the current step.",
"example": "Collecting data from the Microsoft Entra ID system."
},
"displayName": {
"type": "string",
"description": "Text/label to render with the progress bar.",
"example": "Running Entra ID Plugin"
},
"id": {
"description": "Unique identifier to be able to select this specific instance via search.",
"type": "string",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"example": "b759230f-48cb-496e-ad57-5f079083226b"
},
"currentStep": {
"description": "Current step/value for the progress bar. This is in relation to the `totalStepCount` property. If undefined, an indeterminate/pulsing progress bar is used instead.",
"example": 5,
"type": "number"
},
"totalStepCount": {
"description": "Number of steps before the progress bar is completely filed.",
Copy link

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a spelling error in the description. 'filed' should be 'filled'.

Suggested change
"description": "Number of steps before the progress bar is completely filed.",
"description": "Number of steps before the progress bar is completely filled.",

Copilot uses AI. Check for mistakes.
"example": 7,
"type": "number",
"minimum": 1
}
},
"type": "object",
"required": [
"childBar",
Copy link

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making 'childBar' a required field may be problematic since many progress bars won't have child bars. Consider making this optional or providing a default empty array.

Suggested change
"childBar",

Copilot uses AI. Check for mistakes.
"displayName",
"id",
"totalStepCount"
]
},
"LicenseReport.CorrelationRecord": {
"description": "Metadata that describes the execution session (run) that is used to tie/relate all of the license report together.",
"example": {
Expand Down