Skip to content

LAB-2750 - Open API spec for shield operation mode endpoint #193

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

Merged
pr0uxx merged 1 commit into from
Jul 14, 2026
+59 −0
Merged

LAB-2750 - Open API spec for shield operation mode endpoint #193

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
59 changes: 59 additions & 0 deletions specs/SHIELD.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,33 @@
}
]
},
"Core.OperationMode": {
"title": "Core - Operation Mode",
"description": "Indicates the operation mode that the SHIELD application is currently running in.",
"type": "object",
"properties": {
"operationMode": {
"description": "Current operation mode value returned by the application.",
"type": "string",
"minLength": 1,
"examples": [
"normal",
"discover"
]
}
},
"required": [
"operationMode"
],
"examples": [
{
"operationMode": "normal"
},
{
"operationMode": "discover"
}
]
},
"Core.ProgressBar": {
"title": "Core - Progress Bar",
"description": "Used to indicate the progress of a long running operation.",
Expand Down Expand Up @@ -4392,6 +4419,38 @@
"summary": "Health of the Service for Probing"
}
},
"/Api/Core/OperationMode": {
"get": {
"description": "Retrieves the current operation mode used by the SHIELD application.",
"operationId": "/Api/Core/OperationMode/Get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Core.OperationMode"
},
"examples": {
"Current operation mode": {
"summary": "Example Current Operation Mode",
"description": "An example payload that returns the application's current operation mode.",
"value": {
"operationMode": "normal"
}
}
}
}
},
"description": "OK"
}
},
"tags": [
"Core"
],
"security": [],
"summary": "Retrieves the Current Operation Mode"
}
},
"/Api/Auth/Id": {
"get": {
"description": "Provides the Tenant ID and the Application ID of the service principal that access tokens need to be issued against. This is also useful for configuring public clients to be able to authenticate to for auth code flows.",
Expand Down